Sets the pixel pattern used by the graphics pen in the current color graphics port.

void PenPixPat (
    PixPatHandle pp
);

Parameter descriptions

pp

A handle to the pixel pattern to use as the pen pattern.

DISCUSSION

The PenPixPat function is similar to the basic QuickDraw function PenPat, except that you pass PenPixPat a handle to a multicolored pixel pattern rather than a bit pattern.

The PenPixPat function stores the handle to the pixel pattern in the pnPixPat field of the CGrafPort structure, therefore, you should not dispose of this handle since QuickDraw removes all references to your pattern from an existing graphics port when you dispose of it.

If you use PenPixPat to set a pixel pattern in a basic graphics port, the data in the pat1Data field of the PixPat structure is placed into the pnPat field of the GrafPort structure.

To define your own pixel pattern, you can create a pixel pattern resource, which is described in 'ppat', or you can use the NewPixPat function. To set the pen to use a bit pattern, you can also use the QuickDraw function PenPat.

SPECIAL CONSIDERATIONS

The PenPixPat function may move or purge memory blocks in the application heap. Your application should not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)